/*
 * Copyright (c) 2025 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @addtogroup FFRT
 * @{
 *
 * @brief FFRT（Function Flow运行时）是支持Function Flow编程模型的软件运行时库，用于调度执行开发者基于Function Flow编程模型开发的应用。
 *
 * @since 20
 */

/**
 * @file fiber.h
 *
 * @brief 纤程是一种轻量级的用户态线程，用于在用户空间内实现高效的任务调度和上下文切换，此为声明纤程的C接口。
 *
 * @library libffrt.z.so
 * @kit FunctionFlowRuntimeKit
 * @include <ffrt/fiber.h>
 * @syscap SystemCapability.Resourceschedule.Ffrt.Core
 * @since 20
 */

#ifndef FFRT_API_C_FIBER_H
#define FFRT_API_C_FIBER_H

#include "type_def.h"

/**
 * @brief 纤程初始化函数，此函数初始化纤程实例，该实例可以存储上下文。
 *
 * @param fiber 指向要初始化的纤程的指针, 具体可参考{@link ffrt_fiber_t}。
 * @param func 纤程切换后所要执行的方法。
 * @param arg 纤程切换后所要执行方法的入参。
 * @param stack 纤程堆栈内存指针。
 * @param stack_size 纤程堆栈大小, 具体可参考{@link ffrt_storage_size_t}。
 * @return 初始化成功返回ffrt_success，否则返回ffrt_error。
 * @since 20
 */
FFRT_C_API int ffrt_fiber_init(ffrt_fiber_t* fiber, void(*func)(void*), void* arg, void* stack, size_t stack_size);


/**
 * @brief 纤程切换函数，调用该函数的线程会暂停当前任务的执行，并将当前上下文保存到from纤程中，同时恢复to纤程中的上下文。
 *
 * @param from 将要保存的纤程指针。
 * @param to 将要恢复的纤程指针。
 * @since 20
 */
FFRT_C_API void ffrt_fiber_switch(ffrt_fiber_t* from, ffrt_fiber_t* to);

#endif // FFRT_API_C_FIBER_H
/** @} */